---
title: "Status Outside Instrument"
method: POST
path: "/connected-deposits/{version}]/outside-instruments/{outside_instrument_guid}/status"
tags: ["Outside Instrument"]
---

# Status Outside Instrument

`POST /connected-deposits/{version}]/outside-instruments/{outside_instrument_guid}/status`

## Request

- Base URL: `https://agw-ext.huntington.com`
- URL: `https://agw-ext.huntington.com/connected-deposits/{version}]/outside-instruments/{outside_instrument_guid}/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/docs/connected-deposits/:version]/outside-instruments/:outside_instrument_guid/status/post.ts> (a function with typed inputs; its response is checked against the schema)

Change the status of an external instrument using Instrument GUID.

## Path parameters

- `outside_instrument_guid` string, uuid, required
- `version` string, required

## Request body

- StatusInstrumentRequest
  - `instrument_status` 'ACTIVE' | 'SUSPEND' | 'NEGLIST' | 'FORGET' | 'UNPROVED' | 'REPLACED'

## Response `200`

OK

- OutsideInstrumentDTO
  - `outside_instrument_guid` string, uuid
  - `person_guid` string, uuid
  - `instrument_country` string
  - `instrument_type` 'BANKDDA' | 'IBAN' | 'BBAN' | 'CARD' | 'CHECK'
  - `instrument_name` string, nullable
  - `instrument_settlement_currency` string, nullable
  - `instrument_category` 'INDIVIDUAL' | 'CORPORATE'
  - `instrument_usage` string, nullable
  - `mask_account_number` string, nullable
  - `account_details` AccountInfo: Base class for account info
    - `card_account` CardAccount: card account
      - `card_number` string, required: Card number
      - `expiration_date` string, required: Card expiration date to be provided in YYMM format- Example: November 2023 as 2311
      - `verification_code` string, nullable: Card verification value or code (Signature panel CVV2/CVC2)
    - `bank_account` BankAccount
      - `account_type` 'DDA' | 'CHECKING' | 'SAVING', required
      - `account_number` string, required: Bank Account number
      - `routing_number` string, nullable: For DDA types bank identification routing number
      - `bank_address` AddressDTO: Address details
        - `city` string
        - `country` string
        - `address_line1` string
        - `address_line2` string, nullable
        - `postal_code` string
        - `state` string
      - `name_on_account` string, nullable: Name on Account
  - `financial_inst_name` string, nullable
  - `instrument_status` 'ACTIVE' | 'SUSPEND' | 'NEGLIST' | 'FORGET' | 'UNPROVED' | 'REPLACED'

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Instrument not found
- `500`: Server Error

---

[API](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments.md) - [All operations](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/llms.txt) - [OpenAPI document](https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/revisions/5beadf52eaee?raw)